home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / scroller_gc.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  4.7 KB  |  153 lines
  1. TABLE OF CONTENTS
  2.  
  3. scroller_gc/--datasheet--
  4. scroller_gc/SCROLLER_GetClass
  5. scroller_gc/--datasheet--                        scroller_gc/--datasheet--
  6.  
  7.     NAME
  8.         scroller_gc -- create scroller BOOPSI objects
  9.  
  10.     SUPERCLASS
  11.         gadgetclass
  12.  
  13.     REQUIRES
  14.         bevel.image, glyph.image
  15.  
  16.     DESCRIPTION
  17.         The scroller gadget is a propgclass wrapper class and is used
  18.         to create proportional scroller or linear slider gadgets.
  19.         To create a linear slider, SCROLLER_Visible must be set to 1, and
  20.         SCROLLER_Top will range in value from 0 to SCROLLER_Total - 1.
  21.  
  22.         The IntuiMessage.Code field will contain the SCROLLER_Top
  23.         attribute, cast to a WORD.
  24.  
  25.         Advantages that this class provides are:
  26.  
  27.          > Supports window relativity.
  28.  
  29.          > Supports OS 3.0 BOOPSI Notification/Update.
  30.  
  31.          > Special signaling ability.
  32.  
  33.          > Optional scroller arrow buttons.
  34.  
  35.          > Supports usage in window boarders.
  36.  
  37.     METHODS
  38.         OM_NEW -- Create the scroller gadget. Also allocates an
  39.             instance of the bevel and glyph image classes.
  40.             Passed to superclass then calls OM_SET.
  41.  
  42.         OM_SET -- Set object attributes. Passed to superclass first.
  43.  
  44.         OM_DISPOSE -- Frees up the scroller gadget as well as the
  45.             bevel and glyph image instances. Passed to superclass last.
  46.  
  47.         OM_UPDATE -- Set object notification attributes. Passed to
  48.             superclass first.
  49.  
  50.         GM_RENDER -- Renders the gadget imagery. Overrides the superclass.
  51.  
  52.         GM_GOACTIVE -- Handles activation. Overrides the superclass.
  53.  
  54.         GM_HANDLEINPUT -- Handles input events once active. Overrides
  55.             the superclass.
  56.  
  57.         GM_GOINACTIVE -- Overrides the superclass. Handles deactivation.
  58.  
  59.         GM_HELPTEST -- Test if mouse is within gadget hit area.
  60.  
  61.         GM_HITTEST -- Test if mouse is within gadget hit area.
  62.  
  63.         GM_DOMAIN -- Returns GDOMAIN_MINIMUM and GDOMAIN_MAXIMUM dimensions.
  64.  
  65.         All other methods are passed to the superclass.
  66.  
  67.     ATTRIBUTES
  68.         SCROLLER_Top (LONG)
  69.             Set the current top value of the scroller within the
  70.             proportional range. (V40)
  71.  
  72.             Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)
  73.  
  74.         SCROLLER_Visible (LONG)
  75.             Set the visible portion of the proportional range. (V40)
  76.  
  77.             (OM_NEW, OM_SET, OM_UPDATE, OM_GET)
  78.  
  79.         SCROLLER_Total (LONG)
  80.             Set the total range of the scroller. (V40)
  81.  
  82.             Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)
  83.  
  84.         SCROLLER_Orientation
  85.             Define orientation of the scroller.
  86.  
  87.             Accepted values as defined in <gadgets/scroller.h> are: 
  88.  
  89.                 SORIENT_VERT
  90.                 SORIENT_HORIZ
  91.  
  92.             Defines are found in <gadgets/scroller.h> and are synomyms for
  93.             the propgclass FREEVERT and FREEHORIZ. (V40)
  94.  
  95.             Applicability is (OM_NEW, OM_GET)
  96.  
  97.         SCROLLER_Arrows (BOOL)
  98.             Enable rendering of optional scroller arrows. (V40)
  99.  
  100.             Applicability is (OM_NEW, OM_GET)
  101.  
  102.         SCROLLER_ArrowDelta (WORD) (V41)
  103.             Allows you to change the amount that clicking an arrow causes
  104.             the scroller to move by.
  105.  
  106.             Defaults to 1.
  107.  
  108.             Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)
  109.  
  110.         SCROLLER_SignalTask (struct Task *)  (V42)
  111.             Signal the specified Task while scroller is active.  This is
  112.             very useful to reduce the load on input.device because you can
  113.             render from some other task (application, or anything else)
  114.             that waits for this signal and then GetAttr() SCROLLER_Top, etc.
  115.             
  116.             Defaults to NULL (no signaling).
  117.  
  118.             Applicability is (OM_NEW, OM_SET)
  119.  
  120.         SCROLLER_SignalTaskBit (ULONG)  (V42)
  121.             Signal with this Bit. See also; SCROLLER_SignalTask.
  122.  
  123.             Applicability is (OM_NEW, OM_SET)
  124. scroller_gc/SCROLLER_GetClass                scroller_gc/SCROLLER_GetClass
  125.  
  126.     NAME
  127.         SCROLLER_GetClass -- Gets the pointer to the scroller class.
  128.  
  129.     SYNOPSIS
  130.         scroller_class = SCROLLER_GetClass();
  131.         D0
  132.  
  133.         Class * SCROLLER_GetClass(VOID);
  134.  
  135.     FUNCTION
  136.         Obtains the pointer to the Scroller gadget class for use with
  137.         NewObject().  This function always returns a valid pointer so
  138.         you do not need to check it.  The reason is that if the library
  139.         opens fine, then the pointer returned is already setup.  (Of course
  140.         this implies that if opening the library fails, you shouldn't be
  141.         calling this.)
  142.  
  143.         Note that this function does not create the class, that is done
  144.         when the class library is opened.
  145.  
  146.     INPUTS
  147.         Nothing.
  148.  
  149.     RESULT
  150.         scroller_class - Pointer to the Scroller gadget class.
  151.  
  152.     SEE ALSO
  153.